/*
 * Copyright contributors to Besu.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.ethereum.mainnet.transactionpool;

import org.hyperledger.besu.ethereum.core.Transaction;

/**
 * A pre-processor for transactions in the transaction pool. This interface allows for modifications
 * to transactions before they are added to the pool.
 */
@FunctionalInterface
public interface TransactionPoolPreProcessor {
  /**
   * Prepares a transaction for inclusion in the transaction pool.
   *
   * @param transaction the transaction to process
   * @param isLocal {@code true} if the transaction originated from a local source
   * @return the processed transaction, which may be modified or unchanged
   */
  Transaction prepareTransaction(Transaction transaction, boolean isLocal);
}
